Skip to content

refactor(repo): align schema layout and terminology#6

Merged
connorcarpenter15 merged 2 commits into
mainfrom
refactor/repo-layout
Jul 9, 2026
Merged

refactor(repo): align schema layout and terminology#6
connorcarpenter15 merged 2 commits into
mainfrom
refactor/repo-layout

Conversation

@connorcarpenter15

Copy link
Copy Markdown
Member

Summary

  • move the canonical proto to proto/openengine/v1/openengine.proto so its filesystem path matches package openengine.v1
  • remove the PACKAGE_DIRECTORY_MATCH lint exception and update every repository link and generation command
  • replace orchestrator terminology with client or distributed framework across proto comments and documentation
  • document direct OpenEngine clients alongside the primary distributed-framework use case
  • replace inaccurate existing-implementation claims with an explicit pre-adoption implementation status
  • completely remove Buf breaking-change configuration and CI enforcement for the current experimental phase

Why

OpenEngine has no adopters yet, so the repository should use the conventional package layout and describe its actual supported client models before implementations depend on either. Breaking-change enforcement is intentionally deferred while revision 1 is still being designed; Buf build, formatting, and linting remain enforced.

Validation

  • buf build
  • buf lint with PACKAGE_DIRECTORY_MATCH enabled
  • buf format --diff --exit-code
  • protoc descriptor and Python path generation
  • GitHub GFM rendering for README.md, docs/motivation.md, and docs/api.md
  • local link, stale path, and terminology scans
  • git diff --check

Signed-off-by: Connor Carpenter <connorc@nvidia.com>
Signed-off-by: Connor Carpenter <connorc@nvidia.com>
@connorcarpenter15 connorcarpenter15 marked this pull request as ready for review July 9, 2026 22:50
@connorcarpenter15 connorcarpenter15 merged commit b657f3b into main Jul 9, 2026
2 checks passed
@connorcarpenter15 connorcarpenter15 deleted the refactor/repo-layout branch July 9, 2026 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant